Skip to main content
PATCH
Update a channel, or archive it with `enabled: false`.

Authorizations

Authorization
string
header
required

A workspace API key.

Path Parameters

channelId
string
required
Required string length: 1 - 200

Body

application/json
name
string
Required string length: 1 - 120
niche
string
Maximum string length: 200
description
string
Maximum string length: 2000
accentColor
string
Maximum string length: 32
voicePreset
string

Named voice preset the engine writes this channel in.

Maximum string length: 120
products

Product binding ids (from /v1/products), or 'none' to declare this channel promotes nothing. An empty array means 'nothing bound yet'; 'none' means 'deliberately never' — the engine reads the difference.

Maximum array length: 50
Required string length: 1 - 40
enabled
boolean

Set false to archive. There is no delete.

Response

Success.

success
boolean
required
{key}
any